get /vms

List Managed VMs (getManagedVms)

Lists the Velostrata managed VMs.

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Return type

ManagedVmDescription

target (optional)

CloudVmInfo

errorDetails (optional)

StringToObjectMap

id (optional)

String Cloud VM ID

powerState (optional)

PowerState

VM state, for example, Starting or Running

privateIpAddress (optional)

String Cloud VM physical IP address

subnetId (optional)

String Cloud VM subnet ID

instanceType (optional)

InstanceType

VM instance type

cpus (optional)

Integer Instance Type Number of CPUs format: int32

maxDataDiskCount (optional)

Integer Instance Maximum Number of Data Disks format: int32

memory (optional)

Double VM Instance Memory Size format: double

name (optional)

String VM Instance Name

resourceDiskSize (optional)

Double VM Instance Resource Disk Size format: double

_type

String Cloud VM AWS or Azure

 

Enum:

AwsInstanceInfo

AzureVmInfo

GcpVmInfo

origin (optional)

OriginDescription

Origin Virtual Machine Description

entityId (optional)

String

cloudDetailsName (optional)

String Cloud Details name, if exists

 

stateInfo (optional)

VmStateDescription

number (optional)

Integer Page number format: int32

numberOfElements (optional)

Integer Number of page elements format: int32

totalElements (optional)

Long Total number of elements format: int64

totalPages (optional)

Integer Total number of pages format: int32

_type

String

 

Enum:

VmStateDescriptionPage

content (optional)

array[VmStateDescription] VM state description page

operationLinks (optional)

OperationLink

List of Links to CE Operations

OperationLinks

array[OperationLink] (optional)

 

 

Example data

Content-Type: application/json

[

{

"cloudExtension": {

"value": "vm-1",

"_type": "CloudExtensionId"

},

"cloudInstanceState": "None",

"edgeNode": "NodeA",

"id": {

"value": "vm-1",

"_type": "VmId"

},

"instanceUuid": "123e4567-e89b-12d3-a456-426655440000",

"migrationState": "None",

"runMode": "Normal",

"isSpot": false,

"state": "Unmanaged",

"activeTasks": [

{

"value": "vm-1",

"_type": "TaskId"

}

],

"uncommittedWrites": 0,

"uncommittedWritesLastSync": "2017-06-14T23:37:17.653Z",

"storagePolicy": "Writeback",

"vmImporter": {

"instanceId": "i-123456789",

"managedVmId": {

"value": "vm-1",

"_type": "VmId"

},

"status": "Creating",

"_type": "VmImporter"

},

"vmExporter": {

"instanceId": "i-123456789",

"managedVmId": {

"value": "vm-1",

"_type": "VmId"

},

"status": "Creating",

"_type": "VmExporter"

},

"OperationLinks" : [ {

"rel: "start","

"href: "/velostrata/api/v35/vms/vm-1/operations/start"

"httpVerb: "POST"

},

{

"rel: "stop","

"href: "/velostrata/api/vms/vm-1/operations/stop"

"httpVerb: "POST"

},

{

"rel: "return","

"href: "/velostrata/api/v35/vms/vm-1/operations/return"

"httpVerb: "POST"

},

{

"rel: "reboot","

"href: "/velostrata/api/v35/vms/vm-1/operations/reboot"

"httpVerb: "POST"

},

{

"rel: "allowedTasks","

"href: "/velostrata/api/v35/vms/vm-1/allowedTasks"

"httpVerb: "POST"

} ]

}

]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK